WikiPages/pl

Centrum użytkownika zapewnia Spis treści. Jest on używany jako główny punkt odniesienia do automatycznego budowania pomocy offline, do której można dotrzeć z programu FreeCAD, jak również dokumentacji offline PDF.

Szablon Template:Docnav jest używany do sekwencyjnego linkowania stron, zgodnie ze strukturą Spisu treści pomocy online. Lista wszystkich szablonów znajduje się w sekcji Szablony.

Nazwy stron

Nazwy stron powinny być krótkie, a w tytułach należy stosować wielką literę: każdy wyraz powinien zaczynać się wielką literą, chyba że są to przedimki, przyimki, spójniki lub inne formy gramatyczne (np. "of", "on", "in", "a", "an", "and").

Niewłaściwa nazwa strony

Budowa samolotów AeroCompany

Prawidłowa nazwa strony

Budowa Samolotów AeroCompany

Nazwy stron środowisk pracy o najwyższym poziomie muszą mieć taki format: XYZ Workbench, gdzie XYZ jest nazwą środowiska, na przykład PartDesign Workbench. A nazwy stron opisujących polecenia (lub narzędzia) należące do danego środowiska muszą mieć taki format: XYZ Command, na przykład PartDesign Pad. Zwróć uwagę, że powinieneś używać nazwy polecenia tak, jak występuje ona w kodzie źródłowym.

Nagłówki

Nagłówki akapitów powinny być krótkie i zawierać wielkie litery: wszystkie wyrazy, z wyjątkiem pierwszego i nazw własnych, powinny być pisane małymi literami. Nie należy używać nagłówków H1 (= Heading =) w znacznikach Wiki, ponieważ tytuł strony jest automatycznie dodawany jako główny nagłówek H1.

Odnośniki internetowe

Jeśli to możliwe, powinieneś używać oryginalnej nazwy linku dla linków. Dzięki temu w dokumentacji drukowanej lub offline łatwiej jest znaleźć stronę, do której zastosowano odniesienie. Proszę unikać nieistotnych słów dla linku.

Nieprawidłowy link

Aby uzyskać więcej informacji na temat rysowania obiektów 2D kliknij tutaj.

Prawidłowy link

Więcej informacji na temat rysowania obiektów 2D można znaleźć w Środowisku pracy Rysunek roboczy.

Preferowany format linku to:

[[Name_of_Page|Name of Page]]

przetłumaczone:

[[Nazwa_Strony/pl|Nazwa Strony]]

Zauważ, że w przypadku części przed znakiem | istotny jest faktyczny link, wielkość liter. Jeśli nazwa Twojej strony to Name_of_page , link nie powiedzie się, jeśli wpiszesz Name_of_Page (wielka litera P). Przed znakiem | wszystkie spacje należy zastąpić podkreśleniami ( _ ). Ma to na celu pomoc tłumaczom korzystającym z oprogramowania tłumaczącego, bez podkreślników link zostałby przetłumaczony przez oprogramowanie, co jest niepożądane.

Aby połączyć się z konkretnym akapitem, dodaj do nazwy strony znak # i jego nagłówek. Przykład:

[[WikiPages#Links|WikiPages]]

przetłumaczone:

[[WikiPages/pl#Odnośniki|Strona Wiki]]

W obrębie tej samej strony możesz pominąć nazwę strony. Przykład:

[[#Links|Links]]

Aby przejść do górnej części strony możesz użyć:

</translate>{{Top}}<translate>

Szablon ten powinien automatycznie wyświetlać poprawny tekst w zależności od tego w jakim języku dana strona jest napisana. Link do góry strony jest szczególnie przydatny w przypadku długich stron, ponieważ pozwala użytkownikowi szybko przeskoczyć z powrotem do spisu treści. Możesz go umieścić na końcu każdego akapitu. Upewnij się, że przed i po szablonie znajduje się pusta linia.

Link do obrazu

.

Aby użyć obrazka jako odsyłacza:

[[Image:Draft_Wire.svg|24px|Opcjonalny tekst, który jest wyświetlany po najechaniu kursorem na obszar obrazka|link=Draft_Wire/pl]]

Link do obrazu + link tekstowy

Polilinia

Jeśli pominiesz opcjonalny tekst, sam link zostanie wyświetlony po najechaniu kursorem myszki na obraz, co jest lepszym rozwiązaniem, a także powinieneś dodać link tekstowy po linku do obrazka:

[[Image:Draft_Wire.svg|24px|link=Draft_Wire/pl]] [[Draft_Wire/pl|Polilinia]]

Strony Środowisk pracy

Strona najwyższego poziomu powinna zaczynać się od:

• Opisu do czego służy dane środowisko pracy.
• Obrazka ilustrującego opis.

Zobacz sekcję #Zrzut ekranu dla rozwiązań dotyczących dołączania obrazów.

Strony poleceń

Strony komend opisujące narzędzia środowiska pracy nie powinny być zbyt długie, powinny jedynie wyjaśniać, co dana komenda może zrobić, a czego nie, oraz jak jej użyć. Obrazki i przykłady należy ograniczyć do minimum. Poradniki mogą wyjaśniać jak używać danego narzędzia i podawać szczegóły krok po kroku.

Proszę odnieść się do strony GuiCommand model po więcej szczegółów.

Poradniki

Dobrze napisany poradnik powinien uczyć, jak szybko osiągnąć pewne praktyczne rezultaty. Nie powinien być zbyt długi, ale powinien zawierać wystarczającą ilość instrukcji krok po kroku i obrazów, aby poprowadzić użytkownika. W miarę rozwoju programu FreeCAD, samouczki mogą stać się nieaktualne, dlatego ważne jest, aby wspomnieć o wersji FreeCAD użytej w poradniku lub wymaganej do jego napisania.

Przykłady można znaleźć na stronie Poradniki.

Stylizacja stron Wiki FreeCAD jest osiągana poprzez użycie (szablonów i stron pośrednich). Zapewniają one standardowy wygląd i sposób działania wszystkich stron, a także umożliwiają zmianę stylu wiki. Możesz zobaczyć pełną listę zdefiniowanych szablonów wchodząc na stronę Special:PrefixIndex/Template:. Ale proszę używaj tylko szablonów wymienionych w tabelach poniżej. Tylko w bardzo szczególnych przypadkach powinieneś używać bezpośrednio znaczników HTML.

Kliknij na link do szablonu, aby zobaczyć instrukcje użycia szablonu oraz jego implementację. Szablony są potężną funkcją oprogramowania MediaWiki. Powinieneś być doświadczonym użytkownikiem wiki, jeśli chcesz proponować dodatki i modyfikacje do istniejących szablonów. Nieprawidłowo zaimplementowane szablony utrudniają tłumaczenie stron na inne języki, dlatego ich użycie powinno być ograniczone do formatowania tekstu, należy unikać dołączania stron. Zobacz Pomoc MediaWiki:Szablony aby dowiedzieć się więcej.

Proste szablony

Szablony te przyjmują prosty parametr tekstowy i formatują go za pomocą określonego stylu.

Szablon	Wygląd	Opis
Top	Przewiń na górę strony	Użyj go, aby dodać link na początek strony.
Emphasis	zaakcentowanie	Użyj go do zaakcentowania fragmentu tekstu.
KEY	Alt	Użyj go do wskazania klawisza klawiatury, który należy nacisnąć.
ASCII		Użyj go do wskazania klawisza ascii w obrazie (.svg), który musi zostać naciśnięty. Należy wprowadzić żądany znak lub numer kodu ascii tego znaku.
Button	Anuluj	Użyj go do wskazania przycisku w graficznym interfejsie użytkownika, który należy nacisnąć.
RadioButton	Opcja	Użyj go, aby wskazać przycisk wyboru w graficznym interfejsie użytkownika, który należy Zaznaczyć lub Nie.
CheckBox	Opcja	Użyj go, aby wskazać pole wyboru w graficznym interfejsie użytkownika, które należy wybrać lub Nie.
SpinBox	1.50	Użyj go do wskazania pola wyboru w graficznym interfejsie użytkownika, które ma zostać zmodyfikowane.
ComboBox	Menu 1	Użyj go do wskazania pola listy wyboru w graficznym interfejsie użytkownika, które należy zmienić.
LineEdit	Metal Nikiel (Ni)	Służy do wskazywania Linii Edycji w graficznym interfejsie użytkownika, która wymaga modyfikacji.
FALSE, False	FAŁSZ, Fałsz	Użyj go, aby wskazać wartość logiczną False, na przykład, jako właściwość w Edytorze właściwości. To jest skrót. Ponieważ jest to wartość, wywołanego szablonu Value. False
TRUE, True	PRAWDA, Prawda	Użyj go, aby wskazać wartość logiczną True, na przykład, jako właściwość w Edytorze właściwości. To jest skrót. Ponieważ jest to wartość, wywołanego szablonu Value. true
MenuCommand	Plik → Zapisz	Użyj go do wskazania lokalizacji polecenia wewnątrz danego menu.
FileName	Nazwa pliku	Użyj go do wskazania nazwy pliku lub katalogu.
SystemInput	Wprowadź ten tekst	Użyj go do wprowadzenia tekstu wejściowego, wprowadzonego przez użytkownika.
SystemOutput	Tekst wyjściowy	Użyj go do wskazania tekstu wychodzącego z systemu.
Incode	import FreeCAD	Użyj go, aby dołączyć kod źródłowy w wierszu z czcionką o stałej szerokości. Powinien zmieścić się w jednej linii.
PropertyView	WIDOKKolor	Użyj go, aby wskazać właściwość widoku w Edytorze właściwości. Przykłady właściwości widoku to Kolor linii, Szerokość linii, Kolor punktu, Rozmiar punktu, itd.
PropertyData	DANEPozycja	Użyj go, aby wskazać właściwość Data w Edytorze właściwości. Właściwości danych są różne dla różnych typów obiektów.
Properties Title / TitleProperty	Podstawowe	Użyj go, aby wskazać nazwę grupy właściwości w Edytorze właściwości. Nazwa nie zostanie uwzględniona w automatycznym spisie treści.
Obsolete	przestarzałe w wersji 0.19	Użyj go, aby wskazać, że cecha stała się przestarzała w określonej wersji FreeCAD.
VersionNoteObsolete	Template:VersionNoteObsolete/pl	To samo (wersja w postaci indeksu górnego).
Version	dostępne w wersji 0.18	Użyj go, aby wskazać, że cecha została wprowadzona w określonej wersji FreeCAD.
VersionNote	Template:VersionNote/pl	To samo (wersja w postaci indeksu górnego).
VersionMinus	wersja 0.16 i poniżej	Użyj go, aby wskazać, że cecha jest dostępna w określonej wersji FreeCAD i wcześniejszych wersjach.
VersionNoteMinus	Template:VersionNoteMinus/pl	To samo (wersja w postaci indeksu górnego).
VersionPlus	wersja 0.17 i powyżej	Użyj go, aby wskazać, że cecha jest dostępna w określonej wersji FreeCAD i nowszych wersjach.
VersionNotePlus	Template:VersionNotePlus/pl	To samo (wersja w postaci indeksu górnego).
ColoredText	Kolorowy tekst	Użyj tego szablonu do pokolorowania tła, tekstu lub tła i tekstu. (ColoredText - strona zawierająca więcej przykładów).
ColoredParagraph	Kolorowy akapit	Użyj tego szablonu do pokolorowania tła, tekstu lub tła i tekstu całego akapitu. (ColoredParagraph strona dla więcej przykładów)

Złożone szablony

Szablony te wymagają większej ilości parametrów wejściowych, lub generują blok tekstu o określonym formacie.

Szablon	Wygląd	Opis
Prettytable	Ta oto tabela	Użyj go do formatowania tabel, takich jak ta. Można dodać dodatkowe właściwości tabeli.
Caption	Jakiś podpis do obrazka	Użyj go, aby dodać wyjaśnienie pod obrazem. Możesz ustawić wyrównanie do lewej lub do środka.
Clear		Użyj go do wyczyszczenia kolumn. Aby uzyskać szczegółowe wyjaśnienie, postępuj zgodnie z definicją szablonu. Jest on często używany do zatrzymania przepływu tekstu obok niepowiązanych obrazów.
Code	import FreeCAD	Użyj go, aby dołączyć wielowierszowe przykłady kodu z czcionką monospace. Domyślnym językiem jest Python, ale można podać inne języki. Użyty kod Python powinien stosować się do ogólnych zaleceń ustanowionych przez PEP8: Style Guide for Python Code. W szczególności, nawiasy powinny następować bezpośrednio po nazwie funkcji, a spacja powinna następować po przecinku. Dzięki temu kod jest bardziej czytelny.
CodeDownload	Niektóre oznaczenia	Użyj go, aby utworzyć link na stronie makrodefinicji.
Codeextralink	Temporary code for external macro link. Do not use this code. This code is used exclusively by Addon Manager. Link for optional manual installation: Macro # This code is copied instead of the original macro code # to guide the user to the online download page. # Use it if the code of the macro is larger than 64 KB and cannot be included in the wiki # or if the RAW code URL is somewhere else in the wiki. from PySide import QtGui, QtCore diag = QtGui.QMessageBox(QtGui.QMessageBox.Information, "Information", "This macro must be downloaded from this link\n" "\n" "https://wiki.freecad.org/Main_Page" + "\n" "\n" "Quit this window to access the download page") diag.setWindowFlags(QtCore.Qt.WindowStaysOnTopHint) diag.setWindowModality(QtCore.Qt.ApplicationModal) diag.exec_() import webbrowser webbrowser.open("https://wiki.freecad.org/Main_Page") <class="rawcodeurl"><a href="https://wiki.freecad.org/Main_Page">raw code</a>	Użyj go, jeśli kod makrodefinicji jest zbyt duży, by umieścić go na Wiki. Kod może być hostowany gdzie indziej, a surowy link do niego może być określony za pomocą tego szablonu. Menedżer dodatków użyje tego linku.
Fake heading	Nagłówek	Użyj go, aby utworzyć nagłówek, który nie będzie automatycznie umieszczany w spisie treści.
GuiCommand	Zobacz Model polecenia GUI	Za jego pomocą można utworzyć pole z przydatnymi informacjami do dokumentowania poleceń (narzędzi) środowiska pracy.
TutorialInfo	Zobacz przykład Poradnik: Podstawy modelowania	Użyj go do stworzenia ramki z przydatnymi informacjami, aby udokumentować Poradniki.
Macro	Zobacz przykład Macro FlattenWire	Użyj go do stworzenia ramki z przydatnymi informacjami, aby udokumentować makrodefinicje.
Docnav	Strona startowa pomocy online Lista funkcji Index	Użyj go, aby utworzyć pasek ze strzałkami i odpowiednimi linkami, który jest przydatny do umieszczania stron w określonej kolejności.
VeryImportantMessage	Ważny komunikat	Użyj go, aby utworzyć wyróżnione pole z bardzo ważną wiadomością. Używaj rzadko, tylko do wskazania poważnych problemów w funkcjonalności oprogramowania, zaprzestania używania narzędzi itp.
Page in progress	This documentation is a work in progress. Please don't mark it as translatable since it will change in the next hours and days.	Użyj tego dla stron, które są w trakcie tworzenia lub które są obecnie przerabiane. Nie zapomnij usunąć tej opcji, gdy strona będzie gotowa.
UnfinishedDocu	This documentation is not finished. Please help and contribute documentation. GuiCommand model explains how commands should be documented. Browse Category:UnfinishedDocu to see more incomplete pages like this one. See Category:Command Reference for all commands. See WikiPages to learn about editing the wiki pages, and go to Help FreeCAD to learn about other ways in which you can contribute.	Użyj go, aby utworzyć podświetlone pole wskazujące niedokończoną stronę dokumentacji.
Softredirect		Użyj go zamiast normalnego przekierowania, gdy przekierowujesz na specjalną stronę (taką jak Media: lub Kategoria:), w których to przypadkach normalne przekierowanie jest wyłączone.
Quote	Krzyknij "Havoc" i wypuść psy wojny. —William Shakespeare, Juliusz Cezar, akt III, scena I	Użyj go, aby utworzyć pole tekstu z dosłownym cytatem i odniesieniem.
Userdocnavi, Powerdocnavi		Użyj ich do stworzenia okien nawigacyjnych dla dokumentacji użytkownika, dokumentacji użytkownika zaawansowanych funkcji oraz dokumentacji programisty. Pozwala to na szybkie przeskakiwanie pomiędzy różnymi sekcjami dokumentacji. Umieszczają one również odpowiednią stronę we właściwej kategorii.

Obrazy i zrzuty ekranu są niezbędne do stworzenia kompletnej dokumentacji programu FreeCAD. Są one szczególnie przydatne do ilustrowania przykładów i samouczków. Obrazy powinny być wyświetlane w ich oryginalnym rozmiarze, tak aby prezentowały wystarczającą ilość szczegółów i były czytelne, jeśli zawierają tekst. Obrazy w formacie Bitmap nie powinny być zmieniane.

Unikaj animowanych obrazów (GIF) na ogólnych stronach pomocy. Animacje i filmy powinny być zarezerwowane dla samouczków, które nie są przeznaczone do użycia jako dokumentacja PDF offline.

Pliki graficzne mogą być załadowane poprzez stronę Special:Upload.

Nazwa

Nadawaj obrazkom znaczące nazwy. Jeśli masz obrazek, który pokazuje charakterystykę konkretnego polecenia, powinieneś użyć nazwy tego polecenia z _example na końcu. Na przykład dla polecenia Draft Offset obrazek powinien mieć nazwę Draft_Offset_example.png.

Zrzut ekranu

Zalecane rozmiary dla zrzutów ekranu to:

• Natywny 400x200 (lub szerokość=400 i wysokość<=200), dla stron command reference, aby obrazek zmieścił się w lewej części strony, oraz dla innych standardowych zrzutów.
• Natywny 600x400 (lub szerokość=600 i wysokość<=400), dla stron command reference, kiedy naprawdę potrzebujesz większego obrazka, i nadal pozwalasz obrazkowi zmieścić się w lewej części strony, oraz dla innych standardowych zrzutów.
• Natywny rozmiar 1024x768 (lub szerokość=1024 i wysokość<=768), tylko dla obrazów pełnoekranowych.
• Mniejsze rozmiary są możliwe przy wyświetlaniu szczegółów.
• Unikaj obrazów o większych rozdzielczościach, ponieważ nie będą one wystarczająco dopasowane do innych rodzajów wyświetlaczy lub drukowanej dokumentacji PDF.

Nie powinieneś polegać na niestandardowej konfiguracji pulpitu lub systemu operacyjnego podczas tworzenia zrzutów ekranu i powinieneś używać domyślnych ustawień wizualnych interfejsu FreeCAD, kiedy tylko jest to możliwe.

Aby utworzyć zrzuty ekranu, możesz użyć opcji dostarczonych przez system operacyjny lub jednej z tych makroinstrukcji: Macro Snip lub Macro Screen Wiki.

Treść

Aby ułatwić tłumaczenie dokumentacji, staraj się unikać zrzutów ekranu, które zawierają teksty. Jeśli nie możesz tego uniknąć, rozważ zrobienie osobnych zrzutów ekranu interfejsu i okna widoku 3D. Obraz widoku 3D może być ponownie użyty w każdym tłumaczeniu, podczas gdy tłumacz może w razie potrzeby wykonać zrzut ekranu zlokalizowanego interfejsu.

Ikonki i grafika

Odnieś się do strony Artykuły, aby zobaczyć wszystkie grafiki i ikony, które zostały stworzone dla FreeCAD, a które mogą być również użyte na stronach dokumentacji. Jeśli chciałbyś dodać ikony, proszę przeczytaj Artwork Guidelines.

Zgodnie z ogólnym konsensusem, strona referencyjna w Wiki jest stroną angielską, która powinna być utworzona jako pierwsza. Jeśli chcesz zmienić lub dodać treść do strony, powinieneś zrobić to najpierw na angielskiej stronie, a dopiero po zakończeniu aktualizacji przenieść modyfikację na przetłumaczoną stronę.

FreeCAD Wiki wspiera rozszerzenie tłumaczenia, które pozwala na łatwiejsze zarządzanie tłumaczeniami między stronami; szczegóły w Tłumaczenie dokumentacji Wiki dla FreeCAD.

Inne przydatne zasoby to:

• Kody ISO języków aby określić dwuliterowy kod dla danego języka, na który chcesz tłumaczyć.
• Google Translate do pomocy przy tłumaczeniach.
• tłumacz Deepl do pomocy przy tłumaczeniach.

Kilka wskazówek dla tłumaczy

Tłumaczenie komend Gui

{{GuiCommand
|Name=FEM EquationFlux
|MenuLocation=Solve → Flux equation
|Workbenches=[[FEM_Workbench|FEM]]
|Shortcut={{KEY|F}} {{KEY|S}}
|Version=0.17
|SeeAlso=[[FEM_tutorial|FEM tutorial]]
}}

przetłumaczone:

{{GuiCommand/fr
|Name=FEM EquationFlux
|Name/fr=FEM Équation d'écoulement
|MenuLocation=Solveur → Équation de flux
|Workbenches=[[FEM_Workbench/fr|Atelier FEM]]
|Shortcut={{KEY|F}} {{KEY|S}}
|Version=0.17
|SeeAlso=[[FEM_tutorial/fr|FEM Tutoriel]]
}}

Ustawienia szablonu

{{FEM_Tools_navi}}

przetłumaczone:

{{FEM_Tools_navi/fr}}

Tłumaczenie odnośnika

[[Part_Workbench|Part Workbench]]

przetłumaczone:

[[Part_Workbench/fr|Atelier Part]]

Tłumaczenie Docnav

{{Docnav
|[[About_FreeCAD|About FreeCAD]]
|[[Installing_on_Windows|Installing on Windows]]
}}

przetłumaczone:

{{Docnav/fr
|[[About_FreeCAD/fr|À propos de FreeCAD]]
|[[Installing_on_Windows/fr|Installation sous Windows]]
}}

Przykład z ikonami:

{{Docnav
|[[Std_Save|Save]]
|[[Std_SaveCopy|SaveCopy]]
|[[Std_File_Menu|Std File Menu]]
|IconL=Std_Save.svg
|IconR=Std_SaveCopy.svg
|IconC=Freecad.svg
}}

przetłumaczone:

{{Docnav/fr
|[[Std_Save/fr|Enregistrer]]
|[[Std_SaveCopy/fr|Enregistrer une copie]]
|[[Std_File_Menu/fr|Menu fichier]]
|IconL=Std_Save.svg
|IconR=Std_SaveCopy.svg
|IconC=Freecad.svg
}}